/*
 * Copyright 2002 Sun Microsystems, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 *
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
 * EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES
 * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
 * OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
 * FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR
 * PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF
 * LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE,
 * EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 * You acknowledge that Software is not designed, licensed or intended
 * for use in the design, construction, operation or maintenance of
 * any nuclear facility.
 */

package com.sun.j2ee.blueprints.processmanager.transitions;

/**
 * This class implements an exception which can wrapped a lower-level exception.
 * 
 */
public class TransitionException extends Exception {
	/**
	 * 
	 */
	private static final long serialVersionUID = -1727073745919046612L;
	private final Exception exception;

	/**
	 * Creates a new TransitionException wrapping another exception, and with a
	 * detail message.
	 * 
	 * @param message
	 *            the detail message.
	 * @param exception
	 *            the wrapped exception.
	 */
	public TransitionException(String message, Exception exception) {
		super(message);
		this.exception = exception;
		return;
	}

	/**
	 * Creates a TransitionException with the specified detail message.
	 * 
	 * @param message
	 *            the detail message.
	 */
	public TransitionException(String message) {
		this(message, null);
		return;
	}

	/**
	 * Creates a new TransitionException wrapping another exception, and with no
	 * detail message.
	 * 
	 * @param exception
	 *            the wrapped exception.
	 */
	public TransitionException(Exception exception) {
		this(null, exception);
		return;
	}

	/**
	 * Gets the wrapped exception.
	 * 
	 * @return the wrapped exception.
	 */
	public Exception getException() {
		return exception;
	}

	/**
	 * Retrieves (recursively) the root cause exception.
	 * 
	 * @return the root cause exception.
	 */
	public Exception getRootCause() {
		if (exception instanceof TransitionException) {
			return ((TransitionException) exception).getRootCause();
		}
		return exception == null ? this : exception;
	}

	public String toString() {
		if (exception instanceof TransitionException) {
			return ((TransitionException) exception).toString();
		}
		return exception == null ? super.toString() : exception.toString();
	}
}
